home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / ticker2.zip / tickerp.inf (.txt) < prev   
OS/2 Help File  |  1996-05-28  |  37KB  |  165 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. About ΓòÉΓòÉΓòÉ
  3.  
  4.  
  5. Ticker/2 REXX Extentions Programmer's Reference 
  6.  
  7.  
  8. Use REXX command files to add/remove text and bitmaps to the ticker. Ticker/2 
  9. executes each command file in a separate thread.
  10.  
  11.  
  12. Control Methods:
  13.  
  14. Clearing the ticker 
  15.  
  16. Control the ticker speed 
  17.  
  18. Adjust the size of the ticker 
  19.  
  20. Adding objects:
  21.  
  22. Add text 
  23.  
  24. Add bitmaps 
  25.  
  26.  
  27. ΓòÉΓòÉΓòÉ 2. Reference ΓòÉΓòÉΓòÉ
  28.  
  29. Ticker/2 REXX function reference:
  30.  
  31. AddTicker 
  32.  
  33. AddTickerObject 
  34.  
  35. AdjustTickerSize 
  36.  
  37. ClearTicker 
  38.  
  39. SetTickerSpeed 
  40.  
  41.  
  42. ΓòÉΓòÉΓòÉ 2.1. ClearTicker ΓòÉΓòÉΓòÉ
  43.  
  44. ClearTicker 
  45.  
  46.            Description:
  47.  
  48.            This function removes all elements from the ticker.
  49.  
  50.            Parameter:
  51.  
  52.            None 
  53.  
  54. Note:  The scheduler file is not removed!
  55.  
  56.  
  57. ΓòÉΓòÉΓòÉ 2.2. AddTicker ΓòÉΓòÉΓòÉ
  58.  
  59. AddTicker 
  60.  
  61.            Definition:
  62.  
  63.            add a textobject to the ticker 
  64.  
  65.            Parameter:
  66.  
  67.            text:      Any text.
  68.  
  69.            key:       The key identifies the element. If the key exists, the 
  70.                       corresponding element will be updated, if the key does 
  71.                       not exist, the element will be added.
  72.  
  73.            expire:    Expiration of the element. A value of 0 means show 
  74.                       forever, a value  greater than 0 is expiration in seconds 
  75.                       and a value less than 0 means the nr of times the element 
  76.                       appears in the ticker display.
  77.  
  78.            color:     Color of the text. Valid colors are: black, red, green, 
  79.                       blue, yellow, gray, white.
  80.  
  81. Example: 
  82.  
  83. call addticker 'Display 60 seconds red', 'KEY60', 60, red
  84. call addticker 'Display twice, default color', 'DEF'2, -2
  85.  
  86.  
  87. ΓòÉΓòÉΓòÉ 2.3. AddTickerObject ΓòÉΓòÉΓòÉ
  88.  
  89. AddTickerObject 
  90.  
  91.            Description:
  92.  
  93.            Add a bitmap to the ticker.
  94.  
  95.            Parameter:
  96.  
  97.            type:      Valid types are 'img' and 'cmd'. If you want to add a 
  98.                       bitmap use type 'img'. The type cmd is reserved to add 
  99.                       REXX command file. Note: 'cmd' is not supported in this version.
  100.  
  101.            file:      Name of the file to be added 
  102.  
  103.            key:       The key identifies the element. If the key exists, the 
  104.                       corresponding element will be updated, if the key does 
  105.                       not exist, the element will be added.
  106.  
  107.            expire:    Expiration of the element. A value of 0 means show 
  108.                       forever, a value  greater than 0 is expiration in seconds 
  109.                       and a value less than 0 means the nr of times the element 
  110.                       appears in the ticker display.
  111.  
  112. Valid formats for bitmaps are:
  113.  
  114.            TGA 24 bit 
  115.  
  116.            TIFF 
  117.  
  118.            GIFF 
  119.  
  120.            BMP 
  121.  
  122. Example: 
  123.  
  124. /* show test.tif for one minute */
  125. call addtickerobject 'img', 'test.tif', 'KEYBITmap', 60
  126.  
  127. /* show test1.bmp 3 times */
  128. call addtickerobject 'img', 'test1.bmp', 999, -3
  129.  
  130.  
  131. ΓòÉΓòÉΓòÉ 2.4. SetTickerSpeed ΓòÉΓòÉΓòÉ
  132.  
  133. SetTickerSpeed 
  134.  
  135.            Description:
  136.  
  137.            Sets the scrolling speed of the ticker.
  138.  
  139.            Parameter:
  140.  
  141.            time:      Time in milliseconds between 2 scroll events.
  142.  
  143.                       NOTE: time < 100 will increase system load 
  144.  
  145.            pixel:     Number of pixels the ticker is scrolled each event.
  146.  
  147. Example: 
  148.  
  149. /* set the speed to 40 ms between 2 scrollevents and */
  150. /* scroll 2 pixel each time */
  151. call settickerspeed 40, 2
  152.  
  153.  
  154. ΓòÉΓòÉΓòÉ 2.5. AdjustTickerSize ΓòÉΓòÉΓòÉ
  155.  
  156. AdjustTickerSize 
  157.  
  158.            Description:
  159.  
  160.            Automatically adjust the height of the ticker to the largest object.
  161.  
  162.            Parameter:
  163.  
  164.            None 
  165.